openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 6.91 kB
JSON
{"openapi":"3.0.0","info":{"version":"2018-08-20","x-release":"s3v4","title":"AWS S3 Control","description":" AWS S3 Control provides access to Amazon S3 control plane operations. ","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"s3control","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/s3control-2018-08-20.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-direct":true}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://aws.amazon.com/s3-control/"},"x-hasEquivalentPaths":true,"security":[{"hmac":[]}],"paths":{"/v20180820/configuration/publicAccessBlock":{"delete":{"operationId":"DeletePublicAccessBlock","description":"Removes the Public Access Block configuration for an Amazon Web Services account.","responses":{"200":{"description":"Success"}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/DeletePublicAccessBlockRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetPublicAccessBlock","description":"Retrieves the Public Access Block configuration for an Amazon Web Services account.","responses":{"200":{"description":"Success","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/GetPublicAccessBlockOutput"}}}},"480":{"description":"NoSuchPublicAccessBlockConfiguration","content":{"text/xml":{"schema":{"$ref":"#/components/schemas/NoSuchPublicAccessBlockConfiguration"}}}}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/GetPublicAccessBlockRequest"}}},"required":true}},"put":{"operationId":"PutPublicAccessBlock","description":"Creates or modifies the Public Access Block configuration for an Amazon Web Services account.","responses":{"200":{"description":"Success"}},"requestBody":{"content":{"text/xml":{"schema":{"$ref":"#/components/schemas/PutPublicAccessBlockRequest"}}},"required":true}}}},"servers":[{"url":"https://s3-control.amazonaws.com/"},{"url":"http://s3-control.amazonaws.com/"}],"components":{"parameters":{"Action":{"name":"Action","in":"query","required":true,"schema":{"type":"string"}},"Version":{"name":"Version","in":"query","required":true,"schema":{"type":"string"}},"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","required":false,"schema":{"type":"string"}}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"DeletePublicAccessBlockRequest":{"type":"object","properties":{}},"GetPublicAccessBlockOutput":{"type":"object","properties":{"PublicAccessBlockConfiguration":{"$ref":"#/components/schemas/PublicAccessBlockConfiguration"}}},"GetPublicAccessBlockRequest":{"type":"object","properties":{}},"NoSuchPublicAccessBlockConfiguration":{},"PutPublicAccessBlockRequest":{"type":"object","required":["PublicAccessBlockConfiguration"],"properties":{"PublicAccessBlockConfiguration":{"$ref":"#/components/schemas/PublicAccessBlockConfiguration"}},"xml":{"namespace":"http://awss3control.amazonaws.com/doc/2018-08-20/"}},"AccountId":{"type":"string"},"PublicAccessBlockConfiguration":{"type":"object","properties":{"BlockPublicAcls":{"$ref":"#/components/schemas/Setting"},"IgnorePublicAcls":{"$ref":"#/components/schemas/Setting"},"BlockPublicPolicy":{"$ref":"#/components/schemas/Setting"},"RestrictPublicBuckets":{"$ref":"#/components/schemas/Setting"}},"description":"<p>The container element for all Public Access Block configuration options. You can enable the configuration options in any combination.</p> <p>Amazon S3 considers a bucket policy public unless at least one of the following conditions is true:</p> <ol> <li> <p>The policy limits access to a set of CIDRs using <code>aws:SourceIp</code>. For more information on CIDR, see <a href=\"http://www.rfc-editor.org/rfc/rfc4632.txt\">http://www.rfc-editor.org/rfc/rfc4632.txt</a> </p> </li> <li> <p>The policy grants permissions, not including any \"bad actions,\" to one of the following:</p> <ul> <li> <p>A fixed AWS principal, user, role, or service principal</p> </li> <li> <p>A fixed <code>aws:SourceArn</code> </p> </li> <li> <p>A fixed <code>aws:SourceVpc</code> </p> </li> <li> <p>A fixed <code>aws:SourceVpce</code> </p> </li> <li> <p>A fixed <code>aws:SourceOwner</code> </p> </li> <li> <p>A fixed <code>aws:SourceAccount</code> </p> </li> <li> <p>A fixed value of <code>s3:x-amz-server-side-encryption-aws-kms-key-id</code> </p> </li> <li> <p>A fixed value of <code>aws:userid</code> outside the pattern \"<code>AROLEID:*</code>\"</p> </li> </ul> </li> </ol> <p>\"Bad actions\" are those that could expose the data inside a bucket to reads or writes by the public. These actions are <code>s3:Get*</code>, <code>s3:List*</code>, <code>s3:AbortMultipartUpload</code>, <code>s3:Delete*</code>, <code>s3:Put*</code>, and <code>s3:RestoreObject</code>.</p> <p>The star notation for bad actions indicates that all matching operations are considered bad actions. For example, because <code>s3:Get*</code> is a bad action, <code>s3:GetObject</code>, <code>s3:GetObjectVersion</code>, and <code>s3:GetObjectAcl</code> are all bad actions.</p>"},"Setting":{"type":"boolean"}}}}