Skip to content

Commit

Permalink
docs(client-codepipeline): Updates to add recent notes to APIs and to…
Browse files Browse the repository at this point in the history 
… replace example S3 bucket names globally.
  • Loading branch information
awstools committed Sep 5, 2024
1 parent b72eaa9 commit d340d53
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 24 deletions.
3 changes: 3 additions & 0 deletions clients/client-codepipeline/src/commands/ListWebhooksCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ export interface ListWebhooksCommandOutput extends ListWebhooksOutput, __Metadat
* <p>Gets a listing of all the webhooks in this Amazon Web Services Region for this
* account. The output lists all webhooks and includes the webhook URL and ARN and the
* configuration for each webhook.</p>
* <note>
* <p>If a secret token was provided, it will be redacted in the response.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
12 changes: 12 additions & 0 deletions clients/client-codepipeline/src/commands/PutWebhookCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,18 @@ export interface PutWebhookCommandOutput extends PutWebhookOutput, __MetadataBea
* RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to
* automatically configure supported third parties to call the generated webhook
* URL.</p>
* <important>
* <p>When creating CodePipeline webhooks, do not use your own credentials or
* reuse the same secret token across multiple webhooks. For optimal security, generate
* a unique secret token for each webhook you create. The secret token is an arbitrary
* string that you provide, which GitHub uses to compute and sign the webhook payloads
* sent to CodePipeline, for protecting the integrity and authenticity of the
* webhook payloads. Using your own credentials or reusing the same token across
* multiple webhooks can lead to security vulnerabilities.</p>
* </important>
* <note>
* <p>If a secret token was provided, it will be redacted in the response.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
45 changes: 27 additions & 18 deletions clients/client-codepipeline/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1791,20 +1791,8 @@ export type RuleOwner = (typeof RuleOwner)[keyof typeof RuleOwner];
*/
export interface RuleTypeId {
/**
* <p>A category defines what kind of rule can be run in the stage, and constrains
* the provider type for the rule. Valid categories are limited to one of the following
* values. </p>
* <ul>
* <li>
* <p>INVOKE</p>
* </li>
* <li>
* <p>Approval</p>
* </li>
* <li>
* <p>Rule</p>
* </li>
* </ul>
* <p>A category defines what kind of rule can be run in the stage, and constrains the provider
* type for the rule. The valid category is <code>Rule</code>. </p>
* @public
*/
category: RuleCategory | undefined;
Expand All @@ -1817,10 +1805,7 @@ export interface RuleTypeId {
owner?: RuleOwner;

/**
* <p>The provider of the service being called by the rule. Valid providers are
* determined by the rulecategory. For example, a managed rule in the Rule category type
* has an owner of AWS, which would be specified as
* <code>AWS</code>.</p>
* <p>The rule provider, such as the <code>DeploymentWindow</code> rule.</p>
* @public
*/
provider: string | undefined;
Expand Down Expand Up @@ -5118,6 +5103,18 @@ export interface WebhookAuthConfiguration {
/**
* <p>The property used to configure GitHub authentication. For GITHUB_HMAC, only the
* <code>SecretToken</code> property must be set.</p>
* <important>
* <p>When creating CodePipeline webhooks, do not use your own credentials or
* reuse the same secret token across multiple webhooks. For optimal security, generate
* a unique secret token for each webhook you create. The secret token is an arbitrary
* string that you provide, which GitHub uses to compute and sign the webhook payloads
* sent to CodePipeline, for protecting the integrity and authenticity of the
* webhook payloads. Using your own credentials or reusing the same token across
* multiple webhooks can lead to security vulnerabilities.</p>
* </important>
* <note>
* <p>If a secret token was provided, it will be redacted in the response.</p>
* </note>
* @public
*/
SecretToken?: string;
Expand Down Expand Up @@ -5187,6 +5184,18 @@ export interface WebhookDefinition {

/**
* <p>Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.</p>
* <important>
* <p>When creating CodePipeline webhooks, do not use your own credentials or
* reuse the same secret token across multiple webhooks. For optimal security, generate
* a unique secret token for each webhook you create. The secret token is an arbitrary
* string that you provide, which GitHub uses to compute and sign the webhook payloads
* sent to CodePipeline, for protecting the integrity and authenticity of the
* webhook payloads. Using your own credentials or reusing the same token across
* multiple webhooks can lead to security vulnerabilities.</p>
* </important>
* <note>
* <p>If a secret token was provided, it will be redacted in the response.</p>
* </note>
* <ul>
* <li>
* <p>For information about the authentication scheme implemented by GITHUB_HMAC,
Expand Down
12 changes: 6 additions & 6 deletions codegen/sdk-codegen/aws-models/codepipeline.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5719,7 +5719,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Gets a listing of all the webhooks in this Amazon Web Services Region for this\n account. The output lists all webhooks and includes the webhook URL and ARN and the\n configuration for each webhook.</p>",
"smithy.api#documentation": "<p>Gets a listing of all the webhooks in this Amazon Web Services Region for this\n account. The output lists all webhooks and includes the webhook URL and ARN and the\n configuration for each webhook.</p>\n <note>\n <p>If a secret token was provided, it will be redacted in the response.</p>\n </note>",
"smithy.api#paginated": {
"inputToken": "NextToken",
"outputToken": "NextToken",
Expand Down Expand Up @@ -7332,7 +7332,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Defines a webhook and returns a unique webhook URL generated by CodePipeline.\n This URL can be supplied to third party source hosting providers to call every time\n there's a code change. When CodePipeline receives a POST request on this URL, the\n pipeline defined in the webhook is started as long as the POST request satisfied the\n authentication and filtering requirements supplied when defining the webhook.\n RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to\n automatically configure supported third parties to call the generated webhook\n URL.</p>"
"smithy.api#documentation": "<p>Defines a webhook and returns a unique webhook URL generated by CodePipeline.\n This URL can be supplied to third party source hosting providers to call every time\n there's a code change. When CodePipeline receives a POST request on this URL, the\n pipeline defined in the webhook is started as long as the POST request satisfied the\n authentication and filtering requirements supplied when defining the webhook.\n RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to\n automatically configure supported third parties to call the generated webhook\n URL.</p>\n <important>\n <p>When creating CodePipeline webhooks, do not use your own credentials or\n reuse the same secret token across multiple webhooks. For optimal security, generate\n a unique secret token for each webhook you create. The secret token is an arbitrary\n string that you provide, which GitHub uses to compute and sign the webhook payloads\n sent to CodePipeline, for protecting the integrity and authenticity of the\n webhook payloads. Using your own credentials or reusing the same token across\n multiple webhooks can lead to security vulnerabilities.</p>\n </important>\n <note>\n <p>If a secret token was provided, it will be redacted in the response.</p>\n </note>"
}
},
"com.amazonaws.codepipeline#PutWebhookInput": {
Expand Down Expand Up @@ -8367,7 +8367,7 @@
"category": {
"target": "com.amazonaws.codepipeline#RuleCategory",
"traits": {
"smithy.api#documentation": "<p>A category defines what kind of rule can be run in the stage, and constrains\n the provider type for the rule. Valid categories are limited to one of the following\n values. </p>\n <ul>\n <li>\n <p>INVOKE</p>\n </li>\n <li>\n <p>Approval</p>\n </li>\n <li>\n <p>Rule</p>\n </li>\n </ul>",
"smithy.api#documentation": "<p>A category defines what kind of rule can be run in the stage, and constrains the provider\n type for the rule. The valid category is <code>Rule</code>. </p>",
"smithy.api#required": {}
}
},
Expand All @@ -8380,7 +8380,7 @@
"provider": {
"target": "com.amazonaws.codepipeline#RuleProvider",
"traits": {
"smithy.api#documentation": "<p>The provider of the service being called by the rule. Valid providers are\n determined by the rulecategory. For example, a managed rule in the Rule category type\n has an owner of AWS, which would be specified as\n <code>AWS</code>.</p>",
"smithy.api#documentation": "<p>The rule provider, such as the <code>DeploymentWindow</code> rule.</p>",
"smithy.api#required": {}
}
},
Expand Down Expand Up @@ -9759,7 +9759,7 @@
"SecretToken": {
"target": "com.amazonaws.codepipeline#WebhookAuthConfigurationSecretToken",
"traits": {
"smithy.api#documentation": "<p>The property used to configure GitHub authentication. For GITHUB_HMAC, only the\n <code>SecretToken</code> property must be set.</p>"
"smithy.api#documentation": "<p>The property used to configure GitHub authentication. For GITHUB_HMAC, only the\n <code>SecretToken</code> property must be set.</p>\n <important>\n <p>When creating CodePipeline webhooks, do not use your own credentials or\n reuse the same secret token across multiple webhooks. For optimal security, generate\n a unique secret token for each webhook you create. The secret token is an arbitrary\n string that you provide, which GitHub uses to compute and sign the webhook payloads\n sent to CodePipeline, for protecting the integrity and authenticity of the\n webhook payloads. Using your own credentials or reusing the same token across\n multiple webhooks can lead to security vulnerabilities.</p>\n </important>\n <note>\n <p>If a secret token was provided, it will be redacted in the response.</p>\n </note>"
}
}
},
Expand Down Expand Up @@ -9842,7 +9842,7 @@
"authentication": {
"target": "com.amazonaws.codepipeline#WebhookAuthenticationType",
"traits": {
"smithy.api#documentation": "<p>Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.</p>\n <ul>\n <li>\n <p>For information about the authentication scheme implemented by GITHUB_HMAC,\n see <a href=\"https://developer.github.com/webhooks/securing/\">Securing your\n webhooks</a> on the GitHub Developer website.</p>\n </li>\n <li>\n <p> IP rejects webhooks trigger requests unless they originate from an IP\n address in the IP range whitelisted in the authentication\n configuration.</p>\n </li>\n <li>\n <p> UNAUTHENTICATED accepts all webhook trigger requests regardless of\n origin.</p>\n </li>\n </ul>",
"smithy.api#documentation": "<p>Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.</p>\n <important>\n <p>When creating CodePipeline webhooks, do not use your own credentials or\n reuse the same secret token across multiple webhooks. For optimal security, generate\n a unique secret token for each webhook you create. The secret token is an arbitrary\n string that you provide, which GitHub uses to compute and sign the webhook payloads\n sent to CodePipeline, for protecting the integrity and authenticity of the\n webhook payloads. Using your own credentials or reusing the same token across\n multiple webhooks can lead to security vulnerabilities.</p>\n </important>\n <note>\n <p>If a secret token was provided, it will be redacted in the response.</p>\n </note>\n <ul>\n <li>\n <p>For information about the authentication scheme implemented by GITHUB_HMAC,\n see <a href=\"https://developer.github.com/webhooks/securing/\">Securing your\n webhooks</a> on the GitHub Developer website.</p>\n </li>\n <li>\n <p> IP rejects webhooks trigger requests unless they originate from an IP\n address in the IP range whitelisted in the authentication\n configuration.</p>\n </li>\n <li>\n <p> UNAUTHENTICATED accepts all webhook trigger requests regardless of\n origin.</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
Expand Down

0 comments on commit d340d53

Please sign in to comment.