|
5719 | 5719 | } |
5720 | 5720 | ], |
5721 | 5721 | "traits": { |
5722 | | - "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>", |
| 5722 | + "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>", |
5723 | 5723 | "smithy.api#paginated": { |
5724 | 5724 | "inputToken": "NextToken", |
5725 | 5725 | "outputToken": "NextToken", |
|
7332 | 7332 | } |
7333 | 7333 | ], |
7334 | 7334 | "traits": { |
7335 | | - "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>" |
| 7335 | + "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>" |
7336 | 7336 | } |
7337 | 7337 | }, |
7338 | 7338 | "com.amazonaws.codepipeline#PutWebhookInput": { |
|
8367 | 8367 | "category": { |
8368 | 8368 | "target": "com.amazonaws.codepipeline#RuleCategory", |
8369 | 8369 | "traits": { |
8370 | | - "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>", |
| 8370 | + "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>", |
8371 | 8371 | "smithy.api#required": {} |
8372 | 8372 | } |
8373 | 8373 | }, |
|
8380 | 8380 | "provider": { |
8381 | 8381 | "target": "com.amazonaws.codepipeline#RuleProvider", |
8382 | 8382 | "traits": { |
8383 | | - "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>", |
| 8383 | + "smithy.api#documentation": "<p>The rule provider, such as the <code>DeploymentWindow</code> rule.</p>", |
8384 | 8384 | "smithy.api#required": {} |
8385 | 8385 | } |
8386 | 8386 | }, |
|
9759 | 9759 | "SecretToken": { |
9760 | 9760 | "target": "com.amazonaws.codepipeline#WebhookAuthConfigurationSecretToken", |
9761 | 9761 | "traits": { |
9762 | | - "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>" |
| 9762 | + "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>" |
9763 | 9763 | } |
9764 | 9764 | } |
9765 | 9765 | }, |
|
9842 | 9842 | "authentication": { |
9843 | 9843 | "target": "com.amazonaws.codepipeline#WebhookAuthenticationType", |
9844 | 9844 | "traits": { |
9845 | | - "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>", |
| 9845 | + "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>", |
9846 | 9846 | "smithy.api#required": {} |
9847 | 9847 | } |
9848 | 9848 | }, |
|
0 commit comments