Skip to main content

Validate the AWS S3 bucket

POST 
/v1/clouds/aws/s3/validate

Validate the AWS S3 bucket

Request​

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Body

required

AWS S3 bucket credentials

    bucketstringrequired

    Name of AWS S3 bucket

    credentials

    object

    required

    AWS cloud account which includes access key and secret key in case of 'secret' credentials type. It includes policyARNS, ARN and externalId in case of sts. Partition is a group of AWS Region and Service objects

    accessKeystring

    AWS account access key

    credentialTypestring

    Possible values: [secret, sts]

    Default value: secret

    Allowed Values [secret, sts]. STS type will be used for role assumption for sts type, accessKey/secretKey contains the source account, Arn is the target account.

    partitionstring

    Possible values: [aws, aws-us-gov]

    Default value: aws

    AWS accounts are scoped to a single partition. Allowed values [aws, aws-us-gov], Default values

    policyARNsstring[]

    List of policy ARNs required in case of credentialType sts.

    secretKeystring

    AWS account secret key

    sts

    object

    AWS STS credentials in case of credentialType sts, will be empty in case of credential type secret

    arnstring

    Arn for the aws sts credentials in cloud account

    externalIdstring

    ExternalId for the aws sts credentials in cloud account

    folderstring

    Name of the folder in the specified AWS S3 bucket.

    regionstringrequired

    Name of the available AWS region.

Responses​

Ok response without content

Response Headers

  • AuditUid

    string

    Audit uid for the request

Loading...